home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / spitfire / achat100.zip / ACHAT.DOC next >
Text File  |  1993-02-18  |  7KB  |  167 lines
  1.                                 "Achat"
  2.                        The Spitfire Ansi Chatroom
  3.                               version 1.00
  4.                          Written By Joe Vidunas
  5.                    Portions (c) Buffalo Creek Software
  6.                   Very Small Portion  (c) Bill Arlofski
  7.  
  8.  
  9. Disclaimer:  This program is guaranteed to take up at least 40k of
  10.              hard disk space.  That's it.  I am not responsible for
  11.              any loss of data, physical or mental damage that this
  12.              program may cause, through use or misuse.
  13.              
  14.  
  15. Background:  When I first got hooked into BBS's it was on a MacIntosh
  16.              System that had this really neat chatroom that allowed
  17.              all users on the system to chat to each other at the same
  18.              time.  I enjoyed this so much that I started a BBS of my
  19.              own (Two Joe's BBS - (215)-449-8564) using the Spitfire
  20.              Software by Mike Woltz.  I was really pleased with everything
  21.              about Spitfire except the fact that it did not have a
  22.              chatroom. I searched high and low for a chatroom that would
  23.              work with Spitfire, but alas I could find none...
  24.              So I wrote one and this is it...
  25.  
  26. What it does:  Achat is modeled after the chatrooms included with the
  27.                more sophisticated and (expensive) BBS softwares.  It
  28.                allows all users on your BBS to talk to each other at
  29.                the same time.  It also has sysop configurable actions
  30.                that tend to really liven up the conversations in your
  31.                chatroom.  Full ansi is supported in the actions and
  32.                from the chatroom prompt which allows very creative
  33.                discussions full of color and cursor control.
  34.  
  35. How to set it up:
  36.     1) Make a directory of your choice somewhere that all your nodes can access.
  37.     2) Copy all the files in ACHAT100.ZIP to that directory.
  38.     3) Decide which Spitfire Menu you want the chatroom to be accessed from.
  39.      A) Menu extension -
  40.             Create or edit  SFMAIN.BAT
  41.                             SFFILE.BAT
  42.                             SFMSG.BAT
  43.             to contain the following lines:
  44.                     cd \ACHAT  {change to directory where ACHAT.EXE is}
  45.                     ACHAT /Pc:\SF {command line /P specifying where node dir is}
  46.                     cd \SF     {change back to Spitfire}
  47.      B) Door -
  48.          Edit SF.Bat to have the above lines between DOOR whatever and goto LOOP
  49.  
  50. Command Line options:
  51.          The only Command Line ACHAT must have is the /P option which
  52.          tells ACHAT where the system files are for the NODE that called it.
  53.  
  54.            format:   /Pc:\SF   {P must be capitalized no space then directory}
  55.  
  56.          Other Command Parameters you may add are.
  57.  
  58.            /A    This parameter is used to enable the adult filter option.
  59.                  With this option enabled, users under 18  may not see, read,
  60.                  or recieve any off color actions you may put in your ACTION.LST
  61.  
  62.            format:  /A  {A must be capitalized no space}
  63.                         You may also place a sec level after the /A i.e.
  64.                         /A75 which will not allow users below sec level
  65.                         75 to see actions you have marked as adult.
  66.  
  67.            /HON  This parameter causes ACHAT's comm routines to use Hardware
  68.                  Flow control which is necessary for most high-speed modems.
  69.  
  70.            format: /HON {all capitals exactly like you see}
  71.  
  72.            /L    This parameter allows local access to ACHAT so you can
  73.                  chat with you users without being on the BBS.
  74.                  i.e.  Three people chatting only two nodes...  neat huh?
  75.  
  76.            /W    This parameter tells Achat which welcome screen to create
  77.                  to inform your users that you have a chatroom, who is in
  78.                  it now, and how to get to it.
  79.  
  80.            format:  /Wc:\sf\display\welcome8  {full path WITHOUT extension}
  81.  
  82.          You may put the command lines in any order, but you must follow the
  83.          above formats.
  84.  
  85.  
  86. Setting up your Welcome Screen:
  87.  
  88.          Achat will create a welcome screen to tell your users that you have
  89.          a chatroom, who is in the chatroom now, and how they can access it.
  90.  
  91.          Achat does this by taking the contents of the file HEADER.TXT adding
  92.          to it the names and nodes of the users in the chatroom now and then
  93.          appending the file FOOTER.TXT to it.
  94.  
  95.          This info is all placed into one file specified by you in the
  96.          /W command parameter and is updated every time someone enters or
  97.          leaves the chatroom.
  98.  
  99.          You are encouraged to edit the HEADER.TXT and FOOTER.TXT files to
  100.          suit your BBS.  They are standard ASCII files, editable with any
  101.          text editor.
  102.  
  103.  
  104.  
  105. Setting up your ACTIONS:
  106.  
  107.          The ACTION.LST file included in the archive contains a good start
  108.          for some humerous actions to have in your chatroom.  It is a standard
  109.          text file and may be edited with your favorite text editor.
  110.  
  111.   The format is as follows:
  112.  
  113.  / HUG                                 {the key word for the action}
  114. |  @ is hugging $ close {the text that will appear for action}
  115.  \ N                                   {action adult nature Y or N}
  116.  
  117.  
  118.   How it works:   Supposing Joe User is in the chatroom and types
  119.                    /HUG Jane
  120.                   what will appear to him and the other users will be
  121.                    Joe User is hugging Jane close.
  122.  
  123.        Note how the users name is substituted for the '@' and anything typed
  124.          after /HUG is substituted for the '$'.
  125.        Also note the ansi codes to change the color of 'hugging'.
  126.  
  127. Distribution:
  128.  
  129. These files may be copied and distributed (you are incouraged to do so)
  130. as long as:
  131. 1.      No fee of any sort is incurred for the distribution.
  132. 2.      The files and the documentation is kept together in an archive.
  133. 3.      The copyright notices are not removed or modified in any portion
  134.         or product of the software
  135.  
  136. Registration :
  137.          This unregistered version of ACHAT is not limited at all.
  138.          The only thing different between this version and the registered
  139.          one is the display of your name and registration number on the
  140.          title screen and the lack of guilt you will feel.
  141.  
  142.          To register you have two options:
  143.          1) send check or money order for $15 to
  144.                  Joseph Vidunas
  145.                  100-B Albemarle Ave.
  146.                  Lansdowne, PA, 19050
  147.  
  148.          2) or you may register online using MC/VISA at
  149.                  TWO JOE'S BBS (215)-449-3394
  150.  
  151.          I will then compile a personal version with your name and
  152.          registration number and have it available for download within
  153.          two days of your registration.
  154.  
  155.       --  Thank you for evaluating this upALLnite software product! --
  156.  
  157.  
  158.      Thats it hope you enjoy it and if you have any problems with it
  159.           or good suggestions please promptly contact me at:
  160.  
  161.                   Two Joe's BBS   (215)-449-3394 or CNET node 215007
  162.  
  163.                   please put CNET messages in doors/3rd party authors
  164.                   as that is the conference I read most.
  165.  
  166.  
  167.